home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 (Alt) / MACD 5.bin / workbench / libs / multireqlib.lha / MultiReq / Documentation / MultiReq.doc < prev    next >
Encoding:
Text File  |  1992-11-12  |  10.2 KB  |  233 lines
  1. ###############################################################################
  2. ##                                                                           ##
  3. ##      M     M            ll     tt     ii    RRRRR                         ##
  4. ##      MM   MM            ll     tt           RR  RR                        ##
  5. ##      MMM MMM   uu  uu   ll    ttttt   ii    RR  RR    eeee     qqqqq      ##
  6. ##      MMMMMMM   uu  uu   ll     tt     ii    RRRRR    ee  ee   qq  qq      ##
  7. ##      MM M MM   uu  uu   ll     tt     ii    RR RR    eeeeee   qq  qq      ##
  8. ##      MM   MM   uu  uu   ll     tt     ii    RR  RR   ee        qqqqq      ##
  9. ##      MM   MM    uuuuu    ll     ttt    ii   RR  RR    eeee        qq      ##
  10. ##                                                                   qq      ##
  11. ##                                                                           ##
  12. ###############################################################################
  13.  
  14.  
  15. MultiReq v1.20 © 11/1992 by Andreas Krebs (released at 12-Nov-92)
  16.  
  17.  
  18. This file contains a complete description of the "Multitasking FileRequester",
  19. that is started through the FileRequester-function of the "multireq.library".
  20. The functions of the library are described in the file Library.doc.
  21.  
  22. 1. Introduction:
  23. ~~~~~~~~~~~~~~~~
  24. The multireq.library and the FileRequester are completly written in assembler
  25. and so it's small, fast and easy to use.
  26. The main difference between the "Multitasking FileRequester" and other File-
  27. Requesters is, that it consists of 2 tasks (therefor multitasking). The first
  28. (main) task is the task, that started the FileRequester and the second one is
  29. called "ReadProcess". The jobs of the FileRequester are shared between the 2
  30. tasks, whereby it's strictly arranged which job is done by which task.
  31. The main task is responsible for the graphics of the FileRequester and for all
  32. inputs from the user. The ReadProcess is only responsible for the reading in of
  33. directories and is controlled by the main task.
  34. This job sharing allows, that you can work with the FileRequester while a
  35. directory is read in, and except to 3 gadgets all functions of the FileRequester
  36. are available during the read in.
  37.  
  38.  
  39.  
  40. 2. Using the FileRequesters:
  41. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  42. When started the FileRequester opens a window, that contains the following lists
  43. and gadgets:
  44.  
  45. 2.1 The Close-gadget:
  46. ---------------------
  47. This gadget is located in the left top edge of the FileRequester and is used to
  48. close the FileRequester, whereby the action following now is not defined, cause
  49. it depends on the program, that opened the FileRequester.
  50.  
  51. 2.2 The Move-gadget:
  52. --------------------
  53. This gadget is the title line of the FileRequester and allows to move the whole
  54. FileRequester.
  55.  
  56. 2.3 The Depth-gadget:
  57. ---------------------
  58. This gadget is located in the right top edge, and it's used to put the File-
  59. Requester in the foreground resp. background depending on the place it's
  60. located.
  61.  
  62. 2.4 The Files-list:
  63. -------------------
  64. This list is located in the large rectangle and contains all actually read in
  65. sub directories and files of the current directory in alphabetical order,
  66. whereby first the directory are displayed together with an drawer symbol and
  67. afterwards the files are displayed together with their size in bytes.
  68. During the read in process this order is not used, but it's automatically
  69. restored, when the directory is read in.
  70.  
  71. If you click on a directory, it'll become the current directory (see 2.16) and
  72. is automatically read in.
  73.  
  74. If you click on a file, it'll become activated (it's displayed inverted) and
  75. it's name is displayed in the File-Gadget (see 2.18). Possibly an earlier
  76. activated file become inactive.
  77. A double click on the file also causes the FileRequester to be closed and to
  78. return to the calling program.
  79.  
  80. 2.5 The FileScroll-gadgets:
  81. ---------------------------
  82. This 3 gadgets are located behind the File-list and are used to scroll the File-
  83. list, whereby the 2 arrow-gadgets are used to scroll the list in the direction
  84. of the corresponding arrow.
  85. The proportional-gadget (between the 2 arrows) allows you to scroll the File-
  86. list by moving the scrollbar.
  87.  
  88. 2.6 The Volumes-list:
  89. ---------------------
  90. This list is located in a rectangle right of the Files-list and contains in
  91. alphabetical order all connected drives, inserted volumes and logical devices
  92. that are currently active, whereby the list is redisplayed if a disk is inserted
  93. or removed.
  94. A special entry is the first entry called "Current", it stands for the current
  95. directory of the calling task (do not mix up with the current directory of the
  96. FileRequester).
  97. After the "Current" entry a list of all connected drives is displayed, whereby
  98. a disk-, harddisk- or IC-symbol is displayed in front of the name depending on
  99. the type of drive. After the drives all inserted volumes are displayed with the
  100. Symbol VOL (for volume), and at the end all logical devices are displayed
  101. together with the symbol LDV (for Logical DeVice).
  102.  
  103. If you click on one of this entries, the corresponding directory becomes the
  104. current directory and is automatically read in.
  105.  
  106. 2.7 The VolumesScroll-gadgets:
  107. ------------------------------
  108. This 3 gadgets are located behind the Volumes-list and are used to scroll the
  109. Volumes-list. This gadgets are identical to the FileScroll-Gadgets (see 2.5).
  110.  
  111. 2.8 The Directory-gadget:
  112. -------------------------
  113. This gadget contains the text "Directory" followed by "1" or "2". The number
  114. stands for the currently shown Files-list. With this gadget you can switch
  115. between the two Files-lists, if you have to change the directory often.
  116. This function is not available during a directory is read in. During this time
  117. the gadget is switched off and displayed ghosted.
  118.  
  119. 2.9 The Copy-gadgets:
  120. ---------------------
  121. This two gadgets contain the text "Dir1->Dir2" resp. "Dir2->Dir1" and allow you
  122. to copy the entries of Files-list 1 into Files-list 2 or vice versa, so that you
  123. don't have to read in a directory twice, if you need it in both Files-lists.
  124. This function is not available during a directory is read in. During this time
  125. the gadgets are switched off and displayed ghosted.
  126.  
  127. 2.10 The Show-gadget:
  128. ---------------------
  129. This stringgadget contains a pattern, that allows you to select which files
  130. should be displayed, whereby only those files are displayed, that match the
  131. pattern.
  132. A '*' symbol inside the pattern stands for a substring of any length and '|' is
  133. used to separate two patterns.
  134. So a pattern of the type "*.c|*-*|a*" e.g. causes, that only those files are
  135. displayed that have the ending ".c", contain the "-" symbol or start with "a",
  136. whereby no difference is made between small and capital letters.
  137.  
  138. 2.11 The Hide-gadget:
  139. ---------------------
  140. This stringgadget contains a pattern, that allows you to select which files
  141. should not be displayed, whereby only those files are hidden, that match the
  142. pattern.
  143. The pattern has the same style as the pattern of the Show-gadget.
  144. If a file matches the Show- and Hide-pattern, it's not displayed cause the
  145. Hide-pattern has priority above the Show-pattern.
  146.  
  147. 2.12 The Info-gadget:
  148. ---------------------
  149. This gadget contains the text "Show .info" or "Hide .info" depending on the
  150. icons (all files ending with ".info") to be displayed or not. The status can be
  151. changed by clicking on this gadget.
  152.  
  153. 2.13 The Scan-gadget:
  154. ---------------------
  155. If you click on this gadget the current directory is read in further (if the
  156. reading was stopped) or is read in again (if it was already read in).
  157.  
  158. 2.14 The Stop-gadget:
  159. ---------------------
  160. This gadget is only useful during a directory is read in, cause in this case
  161. this gadget stops the reading process, if you click on it. But the reading
  162. process can be continued everytime by clicking on the Scan-gadget.
  163.  
  164. 2.15 The Reading-Display:
  165. -------------------------
  166. This display is the small rectangle in front of the text "Drawer:". When this
  167. display is "shining" (it's displayed inverted) a drawer is currently read in.
  168.  
  169. 2.16 The Drawer-gadget:
  170. -----------------------
  171. This stringgadget contains the total name and path of the current directory.
  172. You can directly type in a directory and it's path into this gadget, and as soon
  173. as you press the RETURN-key the directory becomes the current directory and is
  174. automatically read in.
  175.  
  176. 2.17 The '/'-gadget:
  177. --------------------
  178. If you click on this gadget, the parent directory of the current directory
  179. becomes the new current directory and is read in. If no parent directory exists
  180. (e.g. the root directory of a disk) nothing happens when clicking on this
  181. gadget.
  182.  
  183. 2.18 The File-gadget:
  184. ---------------------
  185. This stringgadget contains the name of the selected file (this files is
  186. displayed inverted in the Files-list) or the name of a file, that should be
  187. created. In difference to the Drawer-gadget this gadget is not changed, if you
  188. switch between the two Files-lists.
  189. This gadget is automatically set when clicking on a files. You can also type in
  190. a filename directly into this stringgadget, whereby the FileRequester is closed
  191. as soon as you press the RETURN-key inside this gadget.
  192.  
  193. 2.19 The Okay-gadget:
  194. ---------------------
  195. This gadget is located in the left bottom edge of the FileRequester and can
  196. contain different texts. If you click on this gadget, the FileRequester is
  197. closed immediately, whereby the function following depends on the calling
  198. program.
  199.  
  200. 2.20 The Message-field:
  201. -----------------------
  202. This field is located right of the Okay-gadget and is used to display messages
  203. resp. informations. Normally this field contains a text of the type "x Files (y
  204. shown), z Dirs". This text shows what is displayed in the Files-list, whereby x
  205. stand for the number of files read in, y is the number of the files show and z
  206. is the number of shown directories.
  207. In case of an error this error is also shown in this field. By a click on this
  208. field the error message disappears and the normal information is displayed
  209. again.
  210.  
  211. 2.21 The Cancel-gadget:
  212. -----------------------
  213. With this gadget the FileRequester is normally canceled, whereby the function
  214. always depends on the calling program.
  215.  
  216.  
  217. Now the whole FileRequester is described and you should now be able to use it.
  218. In case of problems, improvement suggestions or things like that, please send
  219. them to me:
  220.  
  221. Andreas Krebs
  222. Mittelweg 9
  223. 7110 Öhringen 2
  224. Germany
  225.  
  226. Tel.: 07948/2101  (at the weekend or in the holidays)
  227.       0721/821356
  228.  
  229. Or send a Email to the following address:
  230.  
  231. Email: s_krebs@iravcl.ira.uka.de
  232.  
  233.